home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / bbsdoors / flmake15.zip / FLMAKE.DOC next >
Text File  |  1993-04-11  |  18KB  |  337 lines
  1.                         FLMAKE Version 1.5 (04-11-93)
  2.  
  3.                               A Renegade Utility
  4.  
  5.                                 Documentation
  6.  
  7.  
  8. WHAT:
  9.  
  10. FLMAKE will make a text file of your BBS's File Area Listings (including
  11. the description, and the extended (verbose) descriptions), it then 
  12. compresses the file with a user chosen archive, and then sends it to the
  13. user with a user chosen protocol. 
  14.  
  15.  
  16. HOW:
  17.  
  18. FLMAKE is different then most of the other programs of this type that I
  19. have seen in that it reads the ACS required for each File Area,
  20. (ALL ACS Security flags are supported, such as Snnn, Dnnn, Gn, Ynnnn, 
  21. Rn, Tnnnnn, etc...., the &, |, !, ^, %  are not supported because i have 
  22. never seen any Sysop that used them for the File Areas), then
  23. checks all of the users ACS settings to verify the File Areas that he has
  24. access to or not (just like Renegade does) instead of you deciding
  25. which kind of file listings to make (most sysops have many different levels
  26. of access and this could become tedious to have to make several different
  27. text files). FLMAKE has its own .CFG file, that it reads information from
  28. to run properly. This will be explained in full. FLMAKE.CFG must be in the
  29. same path as FLMAKE.EXE and is as follows: (Do not type in the Line #??:, 
  30. a sample .CFG file comes with this archive, the following just explains 
  31. what each line does):
  32.  
  33. Line #01: c:\tp\  
  34. Line #02: c:\tp\coliseum.txt  
  35. Line #03: c:\tp\bbsad.txt 
  36. Line #04: c:\tp\bbsad.txt 
  37. Line #05: c:\tp\dorinfo1.def
  38. Line #06: c:\tp\coliseum
  39. Line #07: 2,19200
  40. Line #08: 5
  41. Line #09: A,ARC,c:\pkutils\pak.exe a /WA
  42. Line #10: J,ARJ,c:\pkutils\arj.exe a -y
  43. Line #11: H,LHA,c:\pkutils\lha.exe a /m
  44. Line #12: L,LZH,c:\pkutils\lha.exe a /m
  45. Line #13: Z,ZIP,c:\pkutils\pkzip.exe -aex
  46. Line #14: 7
  47. Line #15: H,HS Link,e:\rbbs\prot\hslink.exe -! -A -I1 -P%P %F
  48. Line #16: X,Xmodem,e:\rbbs\prot\dsz.com port %P sx %F
  49. Line #17: K,Xmodem-1k,e:\rbbs\prot\dsz.com port %P sx -k %F
  50. Line #18: C,Xmodem-CRC,e:\rbbs\prot\dsz.com port %P sx %F
  51. Line #19: Y,Ymodem,e:\rbbs\prot\dsz.com port %P sb %F
  52. Line #20: G,Ymodem-G,e:\rbbs\prot\dsz.com port %P sb -g %F
  53. Line #21: Z,Zmodem,e:\rbbs\prot\dsz.com port %P sz %F
  54. Line #22: 15,4,3,9,11,10,14,9,6
  55. Line #23: autoquit
  56.  
  57. Explanations of what each line does:
  58.  
  59. Line #01: Complete path to your RENEGADE.DAT file.
  60. Line #02: Complete path and filename of what you want the text file that
  61.           FLMAKE creates called.
  62. Line #03: Complete path and filename of a text file that you want included
  63.           on the top of the text file that FLMAKE creates. If you dont
  64.           want to use this option just make this a blank line.
  65. Line #04: Complete path and filename of a text file that you want included
  66.           on the bottom of the text file that FLMAKE creates. If you dont
  67.           want to use this option just make this a blank line.
  68. Line #05: Complete path and filename of your DOOR file that RENEGADE
  69.           creates. The filename is usually called DORINFO1.DEF.
  70. Line #06: Complete path and filename (without the extension) of what you
  71.           want the archive file that FLMAKE creates called. FLMAKE will
  72.           automatically add the extension to the filename after the user
  73.           has chosen which type of compression to use.
  74. Line #07: Com port, and baud rate seperated by a comma that you want 
  75.           FLMAKE to use when a user is NOT online. This is needed for 
  76.           when you want to test FLMAKE, when a user is NOT online.
  77.           There MUST be a comma seperating the 2 numbers.
  78. Line #08: Number of user choosable archive programs you want to use.
  79.           You MUST have at least 1, and can go as high as 20.
  80.  
  81.           The following lines would cooincide with the number you have
  82.           in Line #08. If you have a 5 for Line #08, then you would use
  83.           Lines #09 through #13 , if you have a 1 for Line #08 then you
  84.           would use Line #09 only, for the following:
  85. Line #09: Single character for the key you want the user to press to
  86.           activate this archive, and the 3 letter archive extension, 
  87.           and the complete path and filename and commandline. There MUST 
  88.           be a comma seperating the single character, and the archive 
  89.           extension and the complete path and filename, and there must 
  90.           be a single space seperating the complete path and filename 
  91.           and the archive commandline.
  92. Line #10: Single character for the key you want the user to press to
  93.           activate this archive, and the 3 letter archive extension, 
  94.           and the complete path and filename and commandline. There MUST 
  95.           be a comma seperating the single character, and the archive 
  96.           extension and the complete path and filename, and there must 
  97.           be a single space seperating the complete path and filename 
  98.           and the archive commandline.
  99. Line #11: Single character for the key you want the user to press to
  100.           activate this archive, and the 3 letter archive extension, 
  101.           and the complete path and filename and commandline. There MUST 
  102.           be a comma seperating the single character, and the archive 
  103.           extension and the complete path and filename, and there must 
  104.           be a single space seperating the complete path and filename 
  105.           and the archive commandline.
  106. Line #12: Single character for the key you want the user to press to
  107.           activate this archive, and the 3 letter archive extension, 
  108.           and the complete path and filename and commandline. There MUST 
  109.           be a comma seperating the single character, and the archive 
  110.           extension and the complete path and filename, and there must 
  111.           be a single space seperating the complete path and filename 
  112.           and the archive commandline.
  113. Line #13: Single character for the key you want the user to press to
  114.           activate this archive, and the 3 letter archive extension, 
  115.           and the complete path and filename and commandline. There MUST 
  116.           be a comma seperating the single character, and the archive 
  117.           extension and the complete path and filename, and there must 
  118.           be a single space seperating the complete path and filename 
  119.           and the archive commandline.
  120.  
  121. NOTE: If you have a 1 for user choosable archives, then FLMAKE will
  122. auto-start the archiver you have listed, without the user having to
  123. choose anything. If you have more then 1 for user choosable archivers,
  124. then a prompt will come up asking the user which archive to use.
  125.  
  126.  
  127. Line #14: Number of user choosable protocol programs you want to use.
  128.           You MUST have at least 1, and can go as high as 20.
  129.  
  130.           The following lines would cooincide with the number you have
  131.           in Line #14. If you have a 7 for Line #14, then you would use
  132.           Lines #15 through #21 , if you have a 1 for Line #14 then you
  133.           would use Line #15 only, for the following:
  134. Line #15: Single character for the key you want the user to press to
  135.           activate this protocol, and the name of the protocol, 
  136.           and the complete path and filename and commandline. There MUST 
  137.           be a comma seperating the single character, and the protocol 
  138.           name and the complete path and filename, and there must 
  139.           be a single space seperating the complete path and filename 
  140.           and the protocol commandline.
  141. Line #16: Single character for the key you want the user to press to
  142.           activate this protocol, and the name of the protocol, 
  143.           and the complete path and filename and commandline. There MUST 
  144.           be a comma seperating the single character, and the protocol 
  145.           name and the complete path and filename, and there must 
  146.           be a single space seperating the complete path and filename 
  147.           and the protocol commandline.
  148. Line #17: Single character for the key you want the user to press to
  149.           activate this protocol, and the name of the protocol, 
  150.           and the complete path and filename and commandline. There MUST 
  151.           be a comma seperating the single character, and the protocol 
  152.           name and the complete path and filename, and there must 
  153.           be a single space seperating the complete path and filename 
  154.           and the protocol commandline.
  155. Line #18: Single character for the key you want the user to press to
  156.           activate this protocol, and the name of the protocol, 
  157.           and the complete path and filename and commandline. There MUST 
  158.           be a comma seperating the single character, and the protocol 
  159.           name and the complete path and filename, and there must 
  160.           be a single space seperating the complete path and filename 
  161.           and the protocol commandline.
  162. Line #19: Single character for the key you want the user to press to
  163.           activate this protocol, and the name of the protocol, 
  164.           and the complete path and filename and commandline. There MUST 
  165.           be a comma seperating the single character, and the protocol 
  166.           name and the complete path and filename, and there must 
  167.           be a single space seperating the complete path and filename 
  168.           and the protocol commandline.
  169. Line #20: Single character for the key you want the user to press to
  170.           activate this protocol, and the name of the protocol, 
  171.           and the complete path and filename and commandline. There MUST 
  172.           be a comma seperating the single character, and the protocol 
  173.           name and the complete path and filename, and there must 
  174.           be a single space seperating the complete path and filename 
  175.           and the protocol commandline.
  176. Line #21: Single character for the key you want the user to press to
  177.           activate this protocol, and the name of the protocol, 
  178.           and the complete path and filename and commandline. There MUST 
  179.           be a comma seperating the single character, and the protocol 
  180.           name and the complete path and filename, and there must 
  181.           be a single space seperating the complete path and filename 
  182.           and the protocol commandline.
  183.  
  184. NOTE1: If you have a 1 for user choosable protocols, then FLMAKE will
  185. auto-start the protocol you have listed, without the user having to
  186. choose anything. If you have more then 1 for user choosable protocols,
  187. then a prompt will come up asking the user which protocol to use.
  188.  
  189. NOTE2: The only MCI codes that FLMAKE supports for the commandlines for
  190.        protocols are %P (Port #), and %F (Filename to Download). This
  191.        is to save memory, and also because every protocol i have seen to
  192.        date needs only these 2 to work properly.
  193.  
  194. Line #22: Configurable Colors for different parts of FLMAKE: 
  195.           FIRST number is the color for the line 'Your User Info:'. 
  196.           SECOND number is the color for all the headings on the opening
  197.           screen (User Name, Calling From, File Points, etc....).
  198.           THIRD number is the color for the variables following the
  199.           headings on the opening screen (Oiler, Carson City, NV., 
  200.           159, etc....). 
  201.           FOURTH number is the color for the prompts used in FLMAKE 
  202.           ((M)ake a FileList, (Q)uit to BBS :). 
  203.           FIFTH number is the color for the user choosable command keys
  204.           (Such as the 'M', and the 'Q' in the example for the fourth
  205.           number). 
  206.           SIXTH number is the color for the line 'Scanning >'.
  207.           SEVENTH number is the color for the File Area Name.
  208.           EIGHTH number is the color for miscellaneous statements in 
  209.           FLMAKE (Zmodem transfer was successful). 
  210.           NINTH number is the color for the filenames, protocols, and 
  211.           other various statements in FLMAKE (Such as the 'Zmodem' in 
  212.           the example for the eighth number).
  213.           ALL the numbers MUST be seperated by a comma.
  214.  
  215. Line #23: If you have the statement 'autoquit' for this line, then FLMAKE
  216.           will automatically QUIT back to the BBS after a SUCCESSFUL
  217.           transfer of the archived text file. If you dont want FLMAKE to
  218.           automatically QUIT back to the BBS, then just leave this line
  219.           blank, and FLMAKE will prompt the user to press (Q)uit to BBS, 
  220.           (R)erun FLMAKE :.
  221.  
  222.  
  223. NOTE: If more then 1 minute passes without the user, or the Sysop pressing
  224. a key, FLMAKE aborts back to Renegade.
  225.  
  226.  
  227. Next you need to add a new command to one or all of your BBS menus (.MNU).
  228.  
  229. (I)nsert a new command, then (M)odify it to read like the following:
  230.  
  231. 1. Long descript :Whatever you want to use.
  232. 2. Short descript:Whatever you want to use.
  233. 3. Menu keys     :Whatever you want to use.
  234. 4. ACS required  :Whatever the users needs to have access to this command.
  235. 5. Cmdkeys       :DD
  236. 6. Options       :Path followed FLMAKE.EXE. (Ex. C:\RBBS\FLMAKE.EXE)
  237.    Flags         :None
  238.  
  239.  
  240. The file FLMAKE13.CFG is an example .CFG file for FLMAKE that uses
  241. 1 archive program, and 3 protocol programs.
  242.                                     
  243. The file FLMAKE57.CFG is an example .CFG file for FLMAKE that uses
  244. 5 archive programs, and 7 protocol programs.
  245.  
  246.  
  247.  
  248. *****************************************************************************
  249.  
  250.  
  251. NEW COMMANDLINE MODE:
  252. There is now a Sysop activated commandline mode now available for the Sysop
  253. to make a list also, for FREQ'able lists, or backup lists or whatever.
  254.  
  255. To activate the Sysop commandline mode, just use the parameter /s,
  256. (FLMAKE /s). There is also a second parameter that you can use to specify
  257. the date to go back to when looking for files. To activate the Sysop
  258. commandline mode and specify the date of 01/10/93 for the date to go back
  259. to you would type FLMAKE /s /01/10/93. If you do not specify a date to go
  260. back to, then it will look for all files.
  261.  
  262. There is a new .CFG file needed for this to operate correctly. It is called
  263. FLMAKENO.CFG, and it must be in the same path as FLMAKE.EXE. The following
  264. is an explanation of each line in FLMAKENO.CFG. (Do not type in the 
  265. Line #??:, a sample .CFG file comes with this archive, the following 
  266. just explains what each line does):
  267.  
  268. Line #01: Complete path to your RENEGADE.DAT file.
  269. Line #01: e:\rbbs\
  270. Line #02: e:\rbbs\coliseum.txt
  271. Line #03: e:\rbbs\misc\toptext.txt
  272. Line #04: e:\rbbs\misc\bottext.txt
  273. Line #05: e:\rbbs\coliseum
  274. Line #06: LZH,d:\pkutils\lha.exe a /m 
  275. Line #07: 2
  276. Line #08: sysop!
  277. Line #09: newuser
  278.  
  279. Explanations of what each line does:
  280.  
  281. Line #01: Complete path to your RENEGADE.DAT file.
  282. Line #02: Complete path and filename of what you want the text file that
  283.           FLMAKE creates called.
  284. Line #03: Complete path and filename of a text file that you want included
  285.           on the top of the text file that FLMAKE creates. If you dont
  286.           want to use this option just make this a blank line.
  287. Line #04: Complete path and filename of a text file that you want included
  288.           on the bottom of the text file that FLMAKE creates. If you dont
  289.           want to use this option just make this a blank line.
  290. Line #05: Complete path and filename (without the extension) of what you
  291.           want the archive file that FLMAKE creates called. FLMAKE will
  292.           automatically add the extension to the filename depending on the
  293.           command in the following line. If you dont want FLMAKE to make
  294.           a compressed file, then leave this line blank.
  295. Line #06: The 3 letter archive extension, and the complete path and 
  296.           filename and commandline. There MUST be a comma seperating 
  297.           the archive extension and the complete path and filename.  
  298.           If you dont want FLMAKE to make a compressed file, then leave
  299.           this line blank.
  300. Line #07: Total number of File Areas you want left out of your textfile.
  301.           The following lines would cooincide with the number you have
  302.           in Line #07. If you have a 2 for Line #07, then you would use
  303.           Lines #08 through #09 , if you have a 10 for Line #07 then you
  304.           would use Lines #08 through #17 for the following:
  305. Line #08: Filenames for the File Areas (as set in Renegade File Base 
  306.           Configuration) that you want left out of the textfile.
  307. Line #09: Same as Line #08.
  308.  
  309.  
  310. INFO & REGISTRATION:
  311.  
  312. If you like this utility, and find it useful, then PLEASE register it.
  313. Registering this utility will allow you to get the registered version off of
  314. my BBS. You will also be informed of upcoming utilities that i am working 
  315. on, and have input into their development. So please register this utility 
  316. by printing the file REGISTER.DOC, filling in ALL the blanks, then sending 
  317. the completed form along with $5.00 to:
  318.  
  319. Mike Nichols
  320. 5895 Gentry Ln.
  321. Carson City, NV.
  322. 89701
  323.  
  324. After I receive your completed registration form and $5.00 you will
  325. be a validated user on my BBS, and have access to the registered version
  326. of FLMAKE (which will have ALL the commands activated, and ALL the
  327. pauses taken out). Thanks!
  328.  
  329. If you have any questions or would like a utility made for RENEGADE (I would
  330. be more than happy to make it for you) or want an updated version of a
  331. specific utility I can be contacted at my BBS:
  332.  
  333. The Coliseum BBS
  334. (702) 629-0723
  335. 1200 to 19200 baud (v42/HST)
  336. Sysop: Oiler
  337.